<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>[Generic Component Framework v3] GCF::ContentLoadEvent Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<!--link href="tabs.css" rel="stylesheet" type="text/css"-->
</head><body>
 <div id="wrapper">
    <div id="logo_box">
        <a class="img_link" href="https://github.com/pnudupa/gcf" target="_blank" ><img style="float:left;margin-left:10px;margin-top:5px;margin-bottom:5px;"src="header_gcf_logo.jpg" alt="GCF LOGO"/></a>
        <a class="img_link" href="https://www.vcreatelogic.com/" target="_blank" ><img style="float:right;margin-right:10px; margin-top: 30px;" src="header_vcl_logo.jpg" alt="VCL LOGO"/></a>
        <div style="clear:both"></div>
    </div>
    <div class="nav">
        <ul>
            <li class="selectedpage">
                <a class="a-home" href="index.html" >
                    <span>Home</span>
                </a>
            </li>
            <li>
                <a class="a-classes " href="classes.html">
                    <span>All Classes</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_modules.html">
                    <span>Modules</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_guides_and_videos.html">
                    <span>Guides & Videos</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_tools_and_inbuilt_components.html">
                    <span>Tools & Components</span>
                </a>
            </li>
        </ul>
    </div>
    <div id="main-content">
        <div class="inside">
        <div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>GCF</b></li><li class="navelem"><a class="el" href="class_g_c_f_1_1_content_load_event.html">ContentLoadEvent</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_g_c_f_1_1_content_load_event-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GCF::ContentLoadEvent Class Reference<div class="ingroups"><a class="el" href="group__gcf__core.html">GCF Core Module</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Contains parameters that describe a content-load event.  
 <a href="class_g_c_f_1_1_content_load_event.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a033302e12daeb121564490a8f794417f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_content_load_event.html#a033302e12daeb121564490a8f794417f">isPreContentLoad</a> () const</td></tr>
<tr class="separator:a033302e12daeb121564490a8f794417f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe0dcd7e41c7a745b4cd1170455d8581"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_content_load_event.html#abe0dcd7e41c7a745b4cd1170455d8581">isPostContentLoad</a> () const</td></tr>
<tr class="separator:abe0dcd7e41c7a745b4cd1170455d8581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a6a2ddca167a46d10d76111f64777e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_content_load_event.html#a9a6a2ddca167a46d10d76111f64777e1">setContentFile</a> (const QString &amp;fileName)</td></tr>
<tr class="separator:a9a6a2ddca167a46d10d76111f64777e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a6736c546c9b8b48666d28b04db9499"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_content_load_event.html#a5a6736c546c9b8b48666d28b04db9499">contentFile</a> () const</td></tr>
<tr class="separator:a5a6736c546c9b8b48666d28b04db9499"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p> 
<pre>#include &lt;GCF3/Component&gt;</pre>
 </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a033302e12daeb121564490a8f794417f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a033302e12daeb121564490a8f794417f">&#9670;&nbsp;</a></span>isPreContentLoad()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool GCF::ContentLoadEvent::isPreContentLoad </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if this class describes a pre-content load event, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_g_c_f_1_1_component.html#a7b9e7071c2f4b483a4ee51b08b70835c">GCF::Component::contentLoadEvent()</a> </dd></dl>

</div>
</div>
<a id="abe0dcd7e41c7a745b4cd1170455d8581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe0dcd7e41c7a745b4cd1170455d8581">&#9670;&nbsp;</a></span>isPostContentLoad()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool GCF::ContentLoadEvent::isPostContentLoad </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if this class describes a post-content load event, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_g_c_f_1_1_component.html#a7b9e7071c2f4b483a4ee51b08b70835c">GCF::Component::contentLoadEvent()</a> </dd></dl>

</div>
</div>
<a id="a9a6a2ddca167a46d10d76111f64777e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a6a2ddca167a46d10d76111f64777e1">&#9670;&nbsp;</a></span>setContentFile()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::ContentLoadEvent::setContentFile </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>fileName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use this function to set the content file for loading.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>name of the content file to load.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>the fileName is either absolute or relative to the location of the executable. If no name is passed then the content file is assumed to be a <code>XML</code> file in component's name (<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">GCF::Component::name()</a>) stored in the content directory (<a class="el" href="group__gcf__core.html#gad118b9c42e144914a229c3f8cf700026">GCF::contentDirectory()</a>)</dd>
<dd>
This function should only be used if <a class="el" href="class_g_c_f_1_1_content_load_event.html#a033302e12daeb121564490a8f794417f">isPreContentLoad()</a> returns true.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_g_c_f_1_1_component.html#a7b9e7071c2f4b483a4ee51b08b70835c">GCF::Component::contentLoadEvent()</a> </dd></dl>

</div>
</div>
<a id="a5a6736c546c9b8b48666d28b04db9499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a6736c546c9b8b48666d28b04db9499">&#9670;&nbsp;</a></span>contentFile()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString GCF::ContentLoadEvent::contentFile </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>When <a class="el" href="class_g_c_f_1_1_content_load_event.html#a033302e12daeb121564490a8f794417f">isPreContentLoad()</a> returns true, the function returns name of the content file set via the <a class="el" href="class_g_c_f_1_1_content_load_event.html#a9a6a2ddca167a46d10d76111f64777e1">setContentFile()</a> method. When <a class="el" href="class_g_c_f_1_1_content_load_event.html#abe0dcd7e41c7a745b4cd1170455d8581">isPostContentLoad()</a> returns true, the function returns name of the content file that was actually used to load the content.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_g_c_f_1_1_component.html#a7b9e7071c2f4b483a4ee51b08b70835c">GCF::Component::contentLoadEvent()</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div>
</div>
</div>
<div class="footer_content">
<table width="100%" class="footer">
<tr>
<td align="left" width="50%">Copyright &copy; 2013-2019,
 <a class="el" href="http://www.vcreatelogic.com" target="_black">VCreate Logic Private Limited</a></td>
<td align="right" width="50%"><a class="el" href="http://www.vcreatelogic.com/products/gcf" target="_black">GCF - Generic Component Framework</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
